3D Graphics Programming with QuickDraw 3D 1.5.4

Managing Display Groups

QuickDraw 3D provides routines that you can use to manage display groups in general.

Q3DisplayGroup_GetType

You can use the Q3DisplayGroup_GetType function to determine the type of a display group.



 
TQ3ObjectType Q3DisplayGroup_GetType (TQ3GroupObject group);

group: A group.

DESCRIPTION

The Q3DisplayGroup_GetType function returns, as its function result, the type of the display group specified by the group parameter. Q3DisplayGroup_GetType returns one of these values:



 
kQ3DisplayGroupTypeIOProxy

kQ3DisplayGroupTypeOrdered

If Q3DisplayGroup_GetType cannot determine the type of a group or an error occurs, it returns kQ3ObjectTypeInvalid .

ERRORS

kQ3ErrorInvalidObject

Q3DisplayGroup_GetState

You can use the Q3DisplayGroup_GetState function to get the current state of a display group.



 
TQ3Status Q3DisplayGroup_GetState (

                     TQ3GroupObject group, 

                     TQ3DisplayGroupState *state);

group: A display group.
state: On exit, a pointer to the current state value for the specified display group.

DESCRIPTION

The Q3DisplayGroup_GetState function returns, in the state parameter, a pointer to a state value for the display group specified by the group parameter. The state value is a set of flags that determine how a display group is traversed during rendering or picking, or during computation of a bounding box or sphere. See "Group State Flags" for a description of the flags currently defined for a group state value.

ERRORS

kQ3ErrorInvalidObject kQ3ErrorNULLParameter

Q3DisplayGroup_SetState

You can use the Q3DisplayGroup_SetState function to set the state of a display group.



 
TQ3Status Q3DisplayGroup_SetState (

                     TQ3GroupObject group, 

                     TQ3DisplayGroupState state);

group: A display group.
state: The desired state value for the specified display group.

DESCRIPTION

The Q3DisplayGroup_SetState function sets the state value of the display group specified by the group parameter to the value pointed to by the state parameter. See "Group State Flags" for a description of the flags currently defined for a group state value.

ERRORS

kQ3ErrorInvalidObject

Q3DisplayGroup_Submit

You can use the Q3DisplayGroup_Submit function to submit a display group for drawing, picking, bounding, or writing.



 
TQ3Status Q3DisplayGroup_Submit (

                     TQ3GroupObject group, 

                     TQ3ViewObject view);

group: A group.
view: A view.

DESCRIPTION

The Q3DisplayGroup_Submit function submits the display group specified by the group parameter for drawing, picking, bounding, or writing in the view specified by the view parameter.

SPECIAL CONSIDERATIONS

You should call this function only in a submitting loop.

ERRORS

kQ3ErrorInvalidObject kQ3ErrorOutOfMemory kQ3ErrorViewNotStarted